node-addon-api
Advanced tools
The node-addon-api package is a helper library for building Node.js Addons in C++. It provides a C++ API that abstracts away the complexities of working with the low-level V8 and N-API provided by Node.js, making it easier to develop native addons.
Object Wrapping
Object wrapping allows C++ classes to be represented as JavaScript objects. It provides an easy way to create and manage objects that have a one-to-one relationship with C++ objects.
Napi::ObjectReference MyClass::constructor;
MyClass::MyClass(const Napi::CallbackInfo& info) : Napi::ObjectWrap<MyClass>(info) {
// constructor implementation
}
Napi::Object MyClass::Init(Napi::Env env, Napi::Object exports) {
Napi::HandleScope scope(env);
Napi::Function func = DefineClass(env, "MyClass", {
InstanceMethod("myMethod", &MyClass::MyMethod)
});
constructor = Napi::Persistent(func);
constructor.SuppressDestruct();
exports.Set("MyClass", func);
return exports;
}Function Arguments
The package provides a way to handle function arguments passed from JavaScript to C++ with type checking and conversion utilities.
Napi::Value MyFunction(const Napi::CallbackInfo& info) {
Napi::Env env = info.Env();
if (info.Length() < 2) {
Napi::TypeError::New(env, "Expected at least two arguments").ThrowAsJavaScriptException();
}
Napi::String arg0 = info[0].As<Napi::String>();
double arg1 = info[1].As<Napi::Number>().DoubleValue();
// function implementation
return Napi::String::New(env, "result");
}Asynchronous Operations
node-addon-api provides utilities for performing asynchronous operations, allowing long-running tasks to be executed without blocking the Node.js event loop.
class MyAsyncWorker : public Napi::AsyncWorker {
public:
MyAsyncWorker(Napi::Function& callback) : AsyncWorker(callback) {}
void Execute() override {
// Do work in another thread
}
void OnOK() override {
Napi::HandleScope scope(Env());
Callback().Call({Env().Null(), Napi::String::New(Env(), "Success")});
}
};
Napi::Value RunAsyncWork(const Napi::CallbackInfo& info) {
Napi::Function callback = info[0].As<Napi::Function>();
MyAsyncWorker* worker = new MyAsyncWorker(callback);
worker->Queue();
return info.Env().Undefined();
}The 'nan' package is a header file filled with macros and utilities for making addon development for different versions of V8 easier. It predates N-API and node-addon-api, and while it's still used, node-addon-api is recommended for most cases due to its simpler API and direct support for N-API.
The 'ffi-napi' package allows for calling foreign functions of dynamic libraries from Node.js. It is similar to node-addon-api in that it allows for native functionality in Node.js, but it focuses on interfacing with existing libraries rather than writing new native modules.
The 'neon' package is a Rust framework for writing safe and fast native Node.js modules. Like node-addon-api, it simplifies the process of writing native addons but does so using Rust instead of C++.
NOTE: The default branch has been renamed! master is now named main
If you have a local clone, you can update it by running:
git branch -m master main
git fetch origin
git branch -u origin/main main
This module contains header-only C++ wrapper classes which simplify the use of the C based Node-API provided by Node.js when using C++. It provides a C++ object model and exception handling semantics with low overhead.
There are three options for implementing addons: Node-API, nan, or direct use of internal V8, libuv and Node.js libraries. Unless there is a need for direct access to functionality which is not exposed by Node-API as outlined in C/C++ addons in Node.js core, use Node-API. Refer to C/C++ addons with Node-API for more information on Node-API.
Node-API is an ABI stable C interface provided by Node.js for building native addons. It is independent from the underlying JavaScript runtime (e.g. V8 or ChakraCore) and is maintained as part of Node.js itself. It is intended to insulate native addons from changes in the underlying JavaScript engine and allow modules compiled for one version to run on later versions of Node.js without recompilation.
The node-addon-api module, which is not part of Node.js, preserves the benefits
of the Node-API as it consists only of inline code that depends only on the stable API
provided by Node-API. As such, modules built against one version of Node.js
using node-addon-api should run without having to be rebuilt with newer versions
of Node.js.
It is important to remember that other Node.js interfaces such as
libuv (included in a project via #include <uv.h>) are not ABI-stable across
Node.js major versions. Thus, an addon must use Node-API and/or node-addon-api
exclusively and build against a version of Node.js that includes an
implementation of Node-API (meaning an active LTS version of Node.js) in
order to benefit from ABI stability across Node.js major versions. Node.js
provides an ABI stability guide containing a detailed explanation of ABI
stability in general, and the Node-API ABI stability guarantee in particular.
As new APIs are added to Node-API, node-addon-api must be updated to provide wrappers for those new APIs. For this reason node-addon-api provides methods that allow callers to obtain the underlying Node-API handles so direct calls to Node-API and the use of the objects/methods provided by node-addon-api can be used together. For example, in order to be able to use an API for which the node-addon-api does not yet provide a wrapper.
APIs exposed by node-addon-api are generally used to create and manipulate JavaScript values. Concepts and operations generally map to ideas specified in the ECMA262 Language Specification.
The Node-API Resource offers an excellent orientation and tips for developers just getting started with Node-API and node-addon-api.
(See CHANGELOG.md for complete Changelog)
node-addon-api is based on Node-API and supports using different Node-API versions. This allows addons built with it to run with Node.js versions which support the targeted Node-API version. However the node-addon-api support model is to support only the active LTS Node.js versions. This means that every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.
The oldest Node.js version supported by the current version of node-addon-api is Node.js 12.x.
The following is the documentation for node-addon-api.
Are you new to node-addon-api? Take a look at our examples
To run the node-addon-api tests do:
npm install
npm test
To avoid testing the deprecated portions of the API run
npm install
npm test --disable-deprecated
To run the tests targeting a specific version of Node-API run
npm install
export NAPI_VERSION=X
npm test --NAPI_VERSION=X
where X is the version of Node-API you want to target.
To run the node-addon-api tests with --debug option:
npm run-script dev
If you want faster build, you might use the following option:
npm run-script dev:incremental
Take a look and get inspired by our test suite
You can run the available benchmarks using the following command:
npm run-script benchmark
See benchmark/README.md for more details about running and adding benchmarks.
As node-addon-api's core mission is to expose the plain C Node-API as C++
wrappers, tools that facilitate n-api/node-addon-api providing more
convenient patterns on developing a Node.js add-ons with n-api/node-addon-api
can be published to NPM as standalone packages. It is also recommended to tag
such packages with node-addon-api to provide more visibility to the community.
Quick links to NPM searches: keywords:node-addon-api.
Rust)The use of badges is recommended to indicate the minimum version of Node-API required for the module. This helps to determine which Node.js major versions are supported. Addon maintainers can consult the Node-API support matrix to determine which Node.js versions provide a given Node-API version. The following badges are available:
We love contributions from the community to node-addon-api! See CONTRIBUTING.md for more details on our philosophy around extending this module.
| Name | GitHub Link |
|---|---|
| Anna Henningsen | addaleax |
| Chengzhong Wu | legendecas |
| Gabriel Schulhof | gabrielschulhof |
| Jim Schlight | jschlight |
| Michael Dawson | mhdawson |
| Kevin Eady | KevinEady |
| Nicola Del Gobbo | NickNaso |
| Name | GitHub Link |
|---|---|
| Arunesh Chandra | aruneshchandra |
| Benjamin Byholm | kkoopa |
| Jason Ginchereau | jasongin |
| Hitesh Kanwathirtha | digitalinfinity |
| Sampson Gao | sampsongao |
| Taylor Woll | boingoing |
Licensed under MIT
2022-01-21 Version 4.3.0, @NickNaso
Napi::Object.napi_extended_error_info in Napi::Error::New().Napi::Object.7046834305] - Update to use recent version of stale action (Michael Dawson)293c7327ad] - Merge pull request #1075 from JckXia/handle-error-thrown (Jack)706b19986d] - test: create tools/eslint-format (Doni Rubiagatra) #1080e0567d098a] - Update documents (JckXia)691813842e] - Refactor code. Using hard coded string instead of using symbol (JckXia)7423cc5025] - Update object_wrap.md (#1094) (Alexander Floh)5aab27e6e1] - doc: add blurb about SetInstanceData (Gabriel Schulhof)e439222fe6] - test: add bigint value test (WenheLI) #10960dfa89f4ef] - doc: document object iterators (#1090) (Darshan Sen)04b26a9d9b] - test: add first set of func Ref tests (JckXia) #1035a0b3fe9197] - Replace magic value with symbol (JckXia)173c5bc9d9] - Update PR based on review comments (JckXia)02bcfbccfd] - Update doc and appending GUID to object property (JckXia)c89f0bfb0b] - Remove un-necessary comment/iostream and updated docs to reflect on limitations with this impl (JckXia)ed4d1c51c4] - Added unwrapping logic to handle graceful error handling for primitives (JckXia)4663453eae] - src: fix usage of napi_extended_error_info in Error::New() (Darshan Sen) #1092cb228418e6] - doc: fix typo in TypedThreadSafeFunction example (#1083) (Tobias Nießen)b70acdda1f] - test: remove travis config (#1082) (Michael Dawson)1404b7cbea] - test: update compiler used for testing (#1079) (Michael Dawson)4351bffd53] - doc: fixup to meet lint rules (Michael Dawson) #1077bd8f6e6d1a] - src: add iterator for Object (Darshan Sen)d8fc7b869a] - lint: add eslint based on config-semistandard (#1067) (Doni Rubiagatra)FAQs
Node.js API (Node-API)
The npm package node-addon-api receives a total of 13,163,624 weekly downloads. As such, node-addon-api popularity was classified as popular.
We found that node-addon-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.